package org.dllwh.utils.database;

import cn.smallbun.screw.core.Configuration;
import cn.smallbun.screw.core.engine.EngineConfig;
import cn.smallbun.screw.core.engine.EngineFileType;
import cn.smallbun.screw.core.engine.EngineTemplateType;
import cn.smallbun.screw.core.execute.DocumentationExecute;
import cn.smallbun.screw.core.process.ProcessConfig;
import com.zaxxer.hikari.HikariConfig;
import com.zaxxer.hikari.HikariDataSource;

import javax.sql.DataSource;
import java.util.List;

/**
 * 把今天最好的表现当作明天最新的起点．．～
 * <p>
 * Today the best performance as tomorrow the newest starter!
 *
 * @ClassName ScrewHelper
 * @Description 简洁好用的数据库表结构文档生成工具
 * @Date 2025-05-30 9:19
 * @版本 V 1.0.1
 * @since JDK 17
 */
public class ScrewHelper {
    //以下static final修饰的参数 如果是基于SpringBoot项目，可以在配置文件中配置，通过@Value注解获取
    /**
     * MySQL驱动 6.0以前的使用com.mysql.jdbc.Driver，6.0以后的使用com.mysql.cj.jdbc.Driver  我这边使用的是mysql-5.7.25版本的
     */
    private final String driverClassName = "com.mysql.jdbc.Driver";
    /**
     * 数据库URL   characterEncoding=UTF-8: 防止生成后文档乱码
     */
    private final String dbUrl = "jdbc:mysql://127.0.0.1:3306/test?useUnicode=true&characterEncoding=utf8&zeroDateTimeBehavior=convertToNull&useSSL=true&serverTimezone=GMT%2B8";
    /**
     * MySQL数据库账号
     */
    private final String dbUserName = "root";
    /**
     * MySQL数据库密码
     */
    private String dbPassword = "test";
    /**
     * 生成数据库文档文件路径 可根据本机电脑自行配置
     */
    private final String fileOutputDir = "C:\\WorkDoc\\DevDoc";
    /**
     * screw配置的文件名称，即数据库文档名称
     */
    private final String docFileName = "数据库设计文档-2024-08-06";
    /**
     * screw配置的文件类型 HTML->HTML文件  WORD->WORD文件  MD->Markdown文件
     */
    private final EngineFileType fileOutputType = EngineFileType.MD;
    /**
     * 版本
     */
    private final String docVersion = "2024.09.02";
    /**
     * 描述
     */
    private final String docDescription = "数据库设计说明文档";
    /**
     * 需要生成数据库文档的表。如果designatedTablePrefix设置值不为空，则 designatedTableName 中的表名要去掉前缀，不然会重复生成，并且表名和字段注释有误
     */
    private final List<String> designatedTableName = null;
    /**
     * 需要生成数据库文档的表前缀
     */
    private final List<String> designatedTablePrefix = null;
    /**
     * 需要生成数据库文档的表后缀
     */
    private final List<String> designatedTableSuffix = null;
    /**
     * 忽略表名
     */
    private final List<String> ignoreTableName = null;
    /**
     * 忽略表前缀，如忽略a开头的数据库表
     */
    private final List<String> ignorePrefix = null;
    /**
     * 忽略表后缀
     */
    private final List<String> ignoreSuffix = null;

    public static void main(String[] args) {
        new ScrewHelper().documentGeneration();
    }

    /**
     * 文档生成
     */
    public void documentGeneration() {

        // 生成文件引擎配置
        EngineConfig engineConfig = engineConfig();

        // 生成文档配置（包含以下自定义版本号、描述等配置连接）
        Configuration config = createScrewConfig(engineConfig);

        // 执行screw，生成数据库文档
        new DocumentationExecute(config).execute();
    }


    /**
     * 创建screw的引擎配置
     */
    private EngineConfig engineConfig() {
        return EngineConfig.builder()
                .fileOutputDir(fileOutputDir)
                // 打开目录
                .openOutputDir(true)
                .fileType(fileOutputType)
                // 生成模板实现
                .produceType(EngineTemplateType.freemarker)
                // 自定义文件名称，即数据库文档名称
                .fileName(docFileName).build();
    }

    /**
     * 获取数据源信息
     */
    private DataSource getDataSource() {
        // 数据源 创建HikariConfig配置类
        HikariConfig hikariConfig = new HikariConfig();
        hikariConfig.setDriverClassName(driverClassName);
        hikariConfig.setJdbcUrl(dbUrl);
        hikariConfig.setUsername(dbUserName);
        hikariConfig.setPassword(dbPassword);
        // 设置可以获取tables remarks信息，即解决数据库表和列字段有说明、生成文档没有说明
        hikariConfig.addDataSourceProperty("useInformationSchema", "true");
        hikariConfig.setMinimumIdle(2);
        hikariConfig.setMaximumPoolSize(5);
        return new HikariDataSource(hikariConfig);
    }


    /**
     * 创建screw的配置
     */
    private Configuration createScrewConfig(EngineConfig engineConfig) {
        return Configuration.builder()
                // 版本
                .version(docVersion)
                // 生成文档信息描述
                .description(docDescription)
                // 数据源
                .dataSource(getDataSource())
                // 生成配置
                .engineConfig(engineConfig)
                // 生成配置
                .produceConfig(getProcessConfig()).build();
    }

    /**
     * 创建screw的处理配置，可忽略。
     * <p>
     * 指定生成逻辑、当存在指定表、指定表前缀、指定表后缀时，将生成指定表，其余表不生成、并跳过忽略表配置
     */
    private ProcessConfig getProcessConfig() {
        ProcessConfig.ProcessConfigBuilder processConfig = ProcessConfig.builder();
        // 根据名称指定表生成
        if (!ifEmpty(designatedTableName)) {
            processConfig.designatedTableName(designatedTableName);
        }
        // 根据表前缀生成
        if (!ifEmpty(designatedTablePrefix)) {
            processConfig.designatedTablePrefix(designatedTablePrefix);
        }
        // 根据表后缀生成
        if (!ifEmpty(designatedTableSuffix)) {
            processConfig.designatedTableSuffix(designatedTableSuffix);
        }
        // 忽略表名
        if (!ifEmpty(ignoreTableName)) {
            processConfig.ignoreTableName(ignoreTableName);
        }
        // 忽略表前缀
        if (!ifEmpty(ignorePrefix)) {
            processConfig.ignoreTablePrefix(ignorePrefix);
        }
        // 忽略表后缀
        if (!ifEmpty(ignoreSuffix)) {
            processConfig.ignoreTableSuffix(ignoreSuffix);
        }
        return processConfig.build();
    }

    private boolean ifEmpty(List list) {
        return list == null || list.isEmpty();
    }
}
